sdgraphobjectframe module

class sd.api.sdgraphobjectframe.SDGraphObjectFrame(APIContext, handle, *args, **kwargs)

Bases: sd.api.sdgraphobject.SDGraphObject

Class managing a Frame object in the graph

getClassName() → str

Returns the most specific name of the class this APIObject is

getColor() → sd.api.sdbasetypes.ColorRGBA

Get the SDGraphObjectFrame color

getDescription() → str

Get the SDGraphObject description

getPosition() → sd.api.sdbasetypes.float2

Get the SDGraphObject position

getSize() → sd.api.sdbasetypes.float2

Get the SDGraphObjectFrame size

getTitle() → str

Get the SDGraphObjectFrame title

release() → None

Releases an APIObject

static sNew(sdGraph: sd.api.sdgraph.SDGraph) → sd.api.sdgraphobjectframe.SDGraphObjectFrame

Create a new SDGraphObjectFrame instance in the specified graph

Parameters

sdGraph – The SDGraph that should contains the new outSDGraphObjectFrame

setColor(value: sd.api.sdbasetypes.ColorRGBA) → None

Set the SDGraphObjectFrame color

Parameters

value – The new color

setDescription(value: str) → None

Set the SDGraphObject description

Parameters

value – The new description

setPosition(position: sd.api.sdbasetypes.float2) → None

Set the SDGraphObject position

Parameters

position – The new position in the graph

setSize(value: sd.api.sdbasetypes.float2) → None

Set the SDGraphObjectFrame size

Parameters

value – The new size

setTitle(value: str) → None

Set the SDGraphObjectFrame title

Parameters

value – The new title